/**
 * Copyright (C) 2009 Matteo Merli <mm@merlimat.org>
 * 
 * $Id: PxlIterator.java 17 2009-01-12 12:36:59Z matteo.merli $
 * $URL: http://pxl-lang.googlecode.com/svn/trunk/src/main/java/pxl/types/PxlIterator.java $
 * 
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 *         http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package pxl.types;

import pxl.errors.PxlException;
import pxl.types.annotations.Exported;

import java.util.Map;
import java.util.Collection;

public abstract class PxlIterator extends PxlObject {

    @Override
    public String getType() {
        return "Iterator";
    }

    @Exported
    public abstract PxlBoolean hasNext();
    
    @Exported
    public abstract PxlObject next();

    @Exported
    public abstract void remove();

    @Exported
    @Override
    public PxlIterator __getiterator__() {
        return this;
    }

    @SuppressWarnings("serial")
    public static class IteratorException extends PxlException {
        public IteratorException(String message) {
            super( message );
        }
    }

    // Attributes

    private static final Map<String,PxlObject> attrs = PxlObject.getExportedMethods( PxlIterator.class );

    @Override
    protected PxlObject getAttribute( String name )
    {
        return attrs.get( name );
    }
    
    @Override
    protected Collection<String> getAttributeNames() 
    {
        return attrs.keySet();
    }

}
